


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Index &mdash; foamPy 0.0.5 documentation</title>
  

  
  
  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
        <link rel="index" title="Index"
              href="#"/>
        <link rel="search" title="Search" href="search.html"/>
    <link rel="top" title="foamPy 0.0.5 documentation" href="index.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> foamPy
          

          
          </a>

          
            
            
              <div class="version">
                0.0.5
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <!-- Local TOC -->
              <div class="local-toc"></div>
            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">foamPy</a>
        
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>Index</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
 <a href="#B"><strong>B</strong></a>
 | <a href="#C"><strong>C</strong></a>
 | <a href="#F"><strong>F</strong></a>
 | <a href="#G"><strong>G</strong></a>
 | <a href="#L"><strong>L</strong></a>
 | <a href="#M"><strong>M</strong></a>
 | <a href="#R"><strong>R</strong></a>
 | <a href="#S"><strong>S</strong></a>
 | <a href="#T"><strong>T</strong></a>
 | <a href="#W"><strong>W</strong></a>
 
</div>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.types.BlockMeshDict">BlockMeshDict (class in foampy.types)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.dictionaries.build_header">build_header() (in module foampy.dictionaries)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.case.Case">Case (class in foampy.case)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.core.clean">clean() (in module foampy.core)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.templates.fill_template">fill_template() (in module foampy.templates)</a>
</li>
      <li><a href="foampy.html#foampy.types.FoamDict">FoamDict (class in foampy.types)</a>
</li>
      <li><a href="foampy.html#foampy.types.FoamList">FoamList (class in foampy.types)</a>
</li>
      <li><a href="foampy.html#module-foampy">foampy (module)</a>
</li>
      <li><a href="foampy.html#module-foampy.case">foampy.case (module)</a>
</li>
      <li><a href="foampy.html#module-foampy.core">foampy.core (module)</a>
</li>
      <li><a href="foampy.html#module-foampy.dictionaries">foampy.dictionaries (module)</a>
</li>
      <li><a href="foampy.html#module-foampy.foil">foampy.foil (module)</a>
</li>
      <li><a href="foampy.html#module-foampy.templates">foampy.templates (module)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.tests.html#module-foampy.tests">foampy.tests (module)</a>
</li>
      <li><a href="foampy.tests.html#module-foampy.tests.test_core">foampy.tests.test_core (module)</a>
</li>
      <li><a href="foampy.tests.html#module-foampy.tests.test_dictionaries">foampy.tests.test_dictionaries (module)</a>
</li>
      <li><a href="foampy.tests.html#module-foampy.tests.test_foil">foampy.tests.test_foil (module)</a>
</li>
      <li><a href="foampy.tests.html#module-foampy.tests.test_templates">foampy.tests.test_templates (module)</a>
</li>
      <li><a href="foampy.tests.html#module-foampy.tests.test_types">foampy.tests.test_types (module)</a>
</li>
      <li><a href="foampy.html#module-foampy.types">foampy.types (module)</a>
</li>
      <li><a href="foampy.html#foampy.types.FoamSubDict">FoamSubDict (class in foampy.types)</a>
</li>
      <li><a href="foampy.html#foampy.foil.FoilData">FoilData (class in foampy.foil)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.core.gen_dynmeshdict">gen_dynmeshdict() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.templates.gen_from_template_dir">gen_from_template_dir() (in module foampy.templates)</a>
</li>
      <li><a href="foampy.html#foampy.core.gen_stripped_lines">gen_stripped_lines() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.get_deltat">get_deltat() (in module foampy.core)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.core.get_endtime">get_endtime() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.get_max_courant_no">get_max_courant_no() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.get_n_processors">get_n_processors() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.get_ncells">get_ncells() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.get_solver_times">get_solver_times() (in module foampy.core)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.core.load_all_torque_drag">load_all_torque_drag() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.load_forces">load_forces() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.load_probes_data">load_probes_data() (in module foampy.core)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.core.load_sample_xy">load_sample_xy() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.load_set">load_set() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.load_theta_omega">load_theta_omega() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.load_torque_drag">load_torque_drag() (in module foampy.core)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.templates.make_template">make_template() (in module foampy.templates)</a>
</li>
      <li><a href="foampy.html#foampy.foil.FoilData.mirror">mirror() (foampy.foil.FoilData method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.foil.mirror_foildata">mirror_foildata() (in module foampy.foil)</a>
</li>
      <li><a href="foampy.html#foampy.core.monitor_progress">monitor_progress() (in module foampy.core)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.case.Case.read">read() (foampy.case.Case method)</a>

      <ul>
        <li><a href="foampy.html#foampy.foil.FoilData.read">(foampy.foil.FoilData method)</a>
</li>
        <li><a href="foampy.html#foampy.types.FoamDict.read">(foampy.types.FoamDict method)</a>
</li>
      </ul></li>
      <li><a href="foampy.html#foampy.core.read_case">read_case() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.read_dict">read_dict() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.read_log_end">read_log_end() (in module foampy.core)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.dictionaries.read_single_line_value">read_single_line_value() (in module foampy.dictionaries)</a>
</li>
      <li><a href="foampy.html#foampy.dictionaries.read_text">read_text() (in module foampy.dictionaries)</a>
</li>
      <li><a href="foampy.html#foampy.foil.reformat_foildata">reformat_foildata() (in module foampy.foil)</a>
</li>
      <li><a href="foampy.html#foampy.dictionaries.replace_value">replace_value() (in module foampy.dictionaries)</a>
</li>
      <li><a href="foampy.html#foampy.core.run">run() (in module foampy.core)</a>
</li>
      <li><a href="foampy.html#foampy.core.run_parallel">run_parallel() (in module foampy.core)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.core.summary">summary() (in module foampy.core)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.tests.html#foampy.tests.test_dictionaries.test_build_header">test_build_header() (in module foampy.tests.test_dictionaries)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_types.test_foamdict">test_foamdict() (in module foampy.tests.test_types)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_types.test_foamlist">test_foamlist() (in module foampy.tests.test_types)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_types.test_foamsubdict">test_foamsubdict() (in module foampy.tests.test_types)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_foil.test_foildata_mirror">test_foildata_mirror() (in module foampy.tests.test_foil)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_core.test_gen_dynmeshdict">test_gen_dynmeshdict() (in module foampy.tests.test_core)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_templates.test_gen_from_template_dir">test_gen_from_template_dir() (in module foampy.tests.test_templates)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_core.test_get_n_processors">test_get_n_processors() (in module foampy.tests.test_core)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_core.test_get_solver_times">test_get_solver_times() (in module foampy.tests.test_core)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_core.test_load_all_torque_drag">test_load_all_torque_drag() (in module foampy.tests.test_core)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.tests.html#foampy.tests.test_core.test_load_forces">test_load_forces() (in module foampy.tests.test_core)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_core.test_load_probes_data">test_load_probes_data() (in module foampy.tests.test_core)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_foil.test_mirror_foildata">test_mirror_foildata() (in module foampy.tests.test_foil)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_core.test_read_dict">test_read_dict() (in module foampy.tests.test_core)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_foil.test_reformat_foildata">test_reformat_foildata() (in module foampy.tests.test_foil)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_dictionaries.test_replace_value">test_replace_value() (in module foampy.tests.test_dictionaries)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_core.test_run">test_run() (in module foampy.tests.test_core)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_core.test_run_parallel">test_run_parallel() (in module foampy.tests.test_core)</a>
</li>
      <li><a href="foampy.tests.html#foampy.tests.test_core.test_summary">test_summary() (in module foampy.tests.test_core)</a>
</li>
      <li><a href="foampy.html#foampy.templates.to_snake_case">to_snake_case() (in module foampy.templates)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="foampy.html#foampy.foil.FoilData.write">write() (foampy.foil.FoilData method)</a>

      <ul>
        <li><a href="foampy.html#foampy.types.FoamDict.write">(foampy.types.FoamDict method)</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>



           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2017, Pete Bachant.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'0.0.5',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>
      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>